Skip to content

Update design documentation (backport #648)#654

Merged
Yadunund merged 1 commit intojazzyfrom
mergify/bp/jazzy/pr-648
Jun 13, 2025
Merged

Update design documentation (backport #648)#654
Yadunund merged 1 commit intojazzyfrom
mergify/bp/jazzy/pr-648

Conversation

@mergify
Copy link

@mergify mergify bot commented May 27, 2025

Description

Update and complete the design documentation in docs/design.md according to the developments made in the last few months.
The goal is also to give enough details for anyone to implement a rmw_zenoh compatible application directly using one of the Zenoh APIs (for instance zenoh-pico).


This is an automatic backport of pull request #648 done by [Mergify](https://mergify.com).

@mergify
Copy link
Author

mergify bot commented May 27, 2025

Cherry-pick of 5ea12c4 has failed:

On branch mergify/bp/jazzy/pr-648
Your branch is up to date with 'origin/jazzy'.

You are currently cherry-picking commit 5ea12c4.
  (fix conflicts and run "git cherry-pick --continue")
  (use "git cherry-pick --skip" to skip this patch)
  (use "git cherry-pick --abort" to cancel the cherry-pick operation)

Changes to be committed:
	modified:   docs/design.md

Unmerged paths:
  (use "git add <file>..." to mark resolution)
	both modified:   README.md

To fix up this pull request, you can check it out locally. See documentation: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally

* Update intro and overview

* Update Router section

* Add section on keyexpr mapping

* Update Graph Cache section

* Update Context and Nodes sections

* Update Publishers and Subscriptions sections

* Update Service Clients and Service Servers sections

* Fix last references to Zenoh-c APIs

* Update QoS section

* README.md: add notes on interop with Zenoh and zenoh-plugin-ros2dds

* README.md: apply change suggestion

Co-authored-by: yadunund <[email protected]>
Signed-off-by: Julien Enoch <[email protected]>

* docs/design.md: apply changes suggestion

Co-authored-by: yadunund <[email protected]>
Signed-off-by: Julien Enoch <[email protected]>

* docs/design.md: apply changes suggestion

Co-authored-by: yadunund <[email protected]>
Signed-off-by: Julien Enoch <[email protected]>

---------

Signed-off-by: Julien Enoch <[email protected]>
Co-authored-by: yadunund <[email protected]>
@Yadunund Yadunund merged commit 91a9247 into jazzy Jun 13, 2025
4 checks passed
@Yadunund Yadunund deleted the mergify/bp/jazzy/pr-648 branch June 13, 2025 18:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants